/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.tomcat5.ui.nodes.actions;

import org.openide.nodes.Node;
import org.openide.util.RequestProcessor.Task;

/**
 * Tomcat web module cookie
 * @author Petr Pisl
 */
public interface TomcatWebModuleCookie extends Node.Cookie {

    /**
     * Undeploys the web module from the server.
     * 
     * @return scheduled task that performs undeploy
     */
    public Task undeploy();

    /**
     * Starts the web module.
     */
    public void start ();

    /**
     * Stops the web module.
     */
    public void stop ();

    /**
     * Returns <code>true</code> if the web module is started, <code>false</code>
     * otherwise.
     * @return <code>true</code> if the web module is started, <code>false</code>
     * otherwise
     */
    public boolean isRunning();
    
    /**
     * Opens web module's log file in the output window.
     */
    public void openLog();
    
    /**
     * Returns <code>true</code> if the web module has a logger defined, 
     * <code>false</code> otherwise.
     * @return <code>true</code> if the web module has a logger defined, 
     * <code>false</code> otherwise
     */
    public boolean hasLogger();

}
